home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / ZSQLMETHOD.PY < prev   
Encoding:
Text File  |  2000-07-03  |  6.9 KB  |  195 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. def manage_addZSQLMethod(self, id, title,
  87.                          connection_id, arguments, template):
  88.     """
  89.  
  90.     Add an SQL Method to an ObjectManager.
  91.  
  92.     The 'connection_id' argument is the id of a database connection
  93.     that resides in the current folder or in a folder above the
  94.     current folder.  The database should understand SQL.
  95.  
  96.     The 'arguments' argument is a string containing an arguments
  97.     specification, as would be given in the SQL method cration form.
  98.  
  99.     The 'template' argument is a string containing the source for the
  100.     SQL Template.
  101.     
  102.     """
  103.  
  104.  
  105. class ZSQLMethod:
  106.     """
  107.  
  108.     ZSQLMethods abstract SQL code in Zope.
  109.  
  110.     They support three important abstractions:
  111.  
  112.       - Method
  113.  
  114.         SQL Methods behave like methods of the folders they are
  115.         accessed in.  In particular, they can be used from other
  116.         methods, like Documents, ExternalMethods, and even other SQL
  117.         Methods.
  118.  
  119.       - Searchability
  120.  
  121.         Database methods support the Searchable Object Interface.
  122.         Search interface wizards can be used to build user
  123.         interfaces to them.  They can be used in joins and
  124.         unions. They provide meta-data about their input parameters
  125.         and result data.
  126.  
  127.         For more information, see the searchable-object interface
  128.         specification. 
  129.  
  130.       - Containment
  131.  
  132.         Database methods support URL traversal to access and invoke
  133.         methods on individual record objects. For example, suppose you
  134.         had an 'employees' database method that took a single argument
  135.         'employee_id'.  Suppose that employees had a 'service_record'
  136.         method (defined in a record class or acquired from a
  137.         folder). The 'service_record' method could be accessed with a
  138.         URL like::
  139.  
  140.            employees/employee_id/1234/service_record
  141.  
  142.         Search results are returned as Record objects.  The schema of
  143.         a Record objects matches the schema of the table queried in
  144.         the search.
  145.  
  146.     """
  147.  
  148.     __constructor__=manage_addZSQLMethod
  149.  
  150.     def __call__(self, REQUEST=None, **kw):
  151.         """
  152.  
  153.         Call the ZSQLMethod.
  154.  
  155.         The arguments to the method should be passed via keyword
  156.         arguments, or in a single mapping object. If no arguments are
  157.         given, and if the method was invoked through the Web, then the
  158.         method will try to acquire and use the Web REQUEST object as
  159.         the argument mapping.
  160.  
  161.         The returned value is a sequence of record objects.
  162.  
  163.         """
  164.     
  165.  
  166.     def manage_edit(self,title,connection_id,arguments,template):
  167.         """
  168.  
  169.         Change database method properties.
  170.  
  171.         The 'connection_id' argument is the id of a database
  172.         connection that resides in the current folder or in a folder
  173.         above the current folder.  The database should understand SQL.
  174.  
  175.         The 'arguments' argument is a string containing an arguments
  176.         specification, as would be given in the SQL method cration
  177.         form.
  178.  
  179.         The 'template' argument is a string containing the source for
  180.         the SQL Template.
  181.  
  182.         """
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.